gh-115937: Remove implementation details from inspect.signature() docs#116086
gh-115937: Remove implementation details from inspect.signature() docs#116086erlend-aasland merged 4 commits intopython:mainfrom
Conversation
…() docs Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
gpshead
left a comment
There was a problem hiding this comment.
I'd leave the "Consult the source code for current semantics." bit off as that feels implied to be when calling something "an implementation detail". But no big deal either way as it is true.
I do understand the Python user desire for officially describing and documenting __signature__ behavior as a public API people can rely on. That's outside the scope of this specific issue as this doc update is just trying to set expectations anywhere the existing implementation detail is mentioned.
willingc
left a comment
There was a problem hiding this comment.
@erlend-aasland I think this documentation change with the implementation detail directive accurately reflects the current status of the underlying source code.
@Gouvernathor As @gpshead mentions, I think having a separate (from documentation) discussion about behavior as a public API makes good sense. Also, I see you maintain ren'py, thanks for doing so. For years, my daughter used it to create interactive game scenarios (she is now a game developer). |
|
Should I close #115984 in favor of this approach? |
Yes, please. |
|
Thanks for the reviews! |
This comment was marked as outdated.
This comment was marked as outdated.
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
GH-116106 is a backport of this pull request to the 3.12 branch. |
|
GH-116107 is a backport of this pull request to the 3.11 branch. |
…e() docs (GH-116086) (#116106) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…e() docs (GH-116086) (#116107) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Carol Willing carolcode@willingconsulting.com
Co-authored-by: Gregory P. Smith greg@krypto.org
Co-authored-by: Jelle Zijlstra jelle.zijlstra@gmail.com
📚 Documentation preview 📚: https://cpython-previews--116086.org.readthedocs.build/